home *** CD-ROM | disk | FTP | other *** search
/ Night Owl - The Best of BBS / Night Owl The Best of BBS (NOP-BBS) (Night Owl Publisher) (1994).iso / 015a / foyers17.lha / FoyerSelect.doc < prev    next >
Text File  |  1994-02-20  |  7KB  |  212 lines
  1. /**************************************************************************
  2. *                                                                         *
  3. *     FoyerSelect  All parts (c) Copyright 1993 by Michael R. Mossman.    *
  4. *                Released for private, non-commercial use.                *
  5. *                                                                         *
  6. *                     Compiled with SAS 6.51.                             *
  7. *                                                                         *
  8. *                                                                         *
  9. **************************************************************************/
  10.  
  11.  
  12.  
  13.  
  14. What is It ?
  15.  
  16.  FoyerSelect is a program designed to launch other serial device type
  17. programs from a FIDO frontend or a BBS program. With a FIDO 
  18. frontend you can offer your users several BBS programs or my
  19. program "SerServer" for DOS type things for your self (the Sysop).
  20.  
  21.  FoyerSelect does not offer any password protection like "Getty" or
  22. "Login", but for BBS programs this is not needed.
  23.  
  24.  
  25.  
  26.  
  27. How To Run It !
  28.  
  29.  FoyerSelect requires two files and if you like three;
  30.  
  31.                  1) FoyerSelect     -> the executable         (mandatory)
  32.                  2) FoyerSelect.cfg -> the configuration file (mandatory)
  33.                  3) FoyerSelect.txt -> text file to user on entry
  34.  
  35. FoyerSelect.cfg and FoyerSelect.txt will default to the current directory 
  36. or the "S:" directory.  
  37. FoyerSelect can take several switches or none, if you wish to accept
  38. the defaults. This is the structure of FoyerSelect's command line:
  39.  
  40. FoyerSelect -dserial.device -uunit_number -rremain -bconnect_baud_rate -ppath
  41.  
  42. Serial.device can be any type of serial driver out there...eg.
  43.  
  44.              siosbx.device
  45.              serial.device (default)
  46.              newser.device
  47.              modem0.device
  48.  
  49. Unit_number will be the unit number of the port on the card that you
  50. are using. If the builtin serial.device is used then this defaults
  51. to unit 0.
  52.  
  53. Remain tells FoyerSelect how many times a user can drop back to FoyerSelect
  54. and make another menu selection. If the "Remain" count drops to zero then 
  55. FoyerSelect will return them to the program that called FoyerSelect
  56. ( eg. - the frontend). If you are running a BBS you might not want
  57. the user to be able to make another selection if they ran out of time.
  58. They probably would be then dropped by the frontend. The default is
  59. "1" or allow the user to make one menu selection.
  60.  
  61. Connect_baud_rate is the baud rate that the modem says that it connected
  62. at....eg.  "Connect 2400". Some frontends and BBS's will allow you
  63. to call FoyerSelect with variable arguments. You can then pass along 
  64. this argument to the programs that FoyerSelect calls with the "%b"
  65. argument.
  66.  
  67. eg. Trapdoor -> FoyerSelect -dsiosbx.device -u1 -b%B
  68.     Welmat   -> FoyerSelect -dnewser.device -u0 -b%d 
  69.  
  70.  
  71. Path is the path to where FoyerSelect can find the FoyerSelect.cfg and
  72. the FoyerSelect.txt files. If there is no -p option used on the
  73. command line then, FoyerSelect will search the current directory and
  74. the "S:" subdirectory. Both files must be in the same subdirectory and
  75. if the -p option is used then a tailing "/" or ":" must exist.
  76.  
  77. eg.  FoyerSelect  -pRAM:
  78.      FoyerSelect  -pHD0:Fido/Foyer/
  79.  
  80.  
  81. FoyerSelect.cfg
  82.  
  83.  This is the configuration file and must follow an exact format.
  84.  
  85. -----------------------------------CUT HERE--------------------------------
  86. Falcon_BBS execute mail:falcon
  87. SerServer  bbs:serserver siosbx.device 0 %b
  88. -----------------------------------CUT HERE--------------------------------
  89.  
  90.  
  91.  
  92. There are no blank lines in the file at the beginning or end!!! Extra
  93. line feeds will be taken as menu items to the program. In the file 
  94. above, there are only two line feeds. The first menu item (Falcon_BBS) 
  95. starts at the very beginning of the line (no spaces) and the menu item
  96. can not have spaces in it (the reason for the under score rather then
  97. a space). The next thing is the path and executable name. This is 
  98. seperated from the menu item label by a space. Next can come five 
  99. options or arguments to the called program. Each of these are seperated
  100. by spaces. You will notice that SerServer menu item has a "%b" argument
  101. that will call SerServer with the connected baud rate. The above 
  102. configuration file will give you the following look:
  103.  
  104.  
  105. -----------------------------------CUT HERE-------------------------------
  106.  
  107.  
  108. FoyerSelect Version 1.70. Copyright (c) 1993 by Michael R. Mossman
  109.  
  110. Please Make Your Selection :
  111.  
  112. 0   Terminate_&_Exit
  113. 1   Falcon_BBS
  114. 2   SerServer
  115.  
  116. -----------------------------------CUT HERE-------------------------------
  117.  
  118.  
  119. You will also notice that FoyerSelect can also call script files. The above
  120. script configures Falcon BBS before it is called.
  121.  
  122.  
  123.  
  124.  
  125. FoyerSelect.txt
  126.  
  127.  This is a text file that is displayed to the user between the Copyright
  128. notice and the "Please Make Your Selection :" line. It can be anything
  129. that you wish to tell them and is a straight Amiga DOS text file as
  130. generated with "Ed".
  131.  
  132.  
  133. Multi-Configurations
  134.  
  135. If you require several different configuration files for FoyerSelect
  136. then it would be best to install FoyerSelect in it's own subdirectory
  137. and create different subdirectorys off of that with the different
  138. config files. Then call FoyerSelect with different paths using the
  139. -p option.
  140.  
  141.  
  142.  
  143. Return Codes
  144.  
  145.  FoyerSelect will return with several return codes or error type
  146. messages.
  147.  
  148. Error Level  20 a) - Wrong number of arguments to the FoyerSelect command.
  149.                 b) - Can't Open One Of The Amiga Devices or Libraries.
  150.                 c) - Can't Open or Find "FoyerSelect.cfg".
  151.                 
  152. Error Level   9 a) - User Dropped The Carrier.
  153.                 b) - More Then 20 Chars In The Serial Buffer. The Telco 
  154.                        Lines Are Noisy Or The User Did A Buffer Dump.    
  155.  
  156. Error Level   8    - User Timed Out, With Out Making a Selection.
  157.  
  158. Error Level   7    - After Four Tries, The User Never Made a Valid 
  159.                         Menu Selection.
  160.                         
  161. Error Level   0    - All Ok
  162.  
  163.  
  164.  
  165. Bugs
  166.  
  167.  None known at this time.
  168.  
  169.  
  170. Copyright etc.
  171.  
  172.  This code is solely base on my own code and nothing was used from "Login"
  173. or "Getty". I do admit that both of these programs gave me ideas. The
  174. personal need was also there!!
  175.  
  176.  
  177. I (Mike Mossman) can be contacted via FIDO at 1:255/19.
  178.  
  179.  
  180.                  "No man is an island onto himself."
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187. Version 1.5 - Cleared the serial port buffer before asking for input
  188.               from the user. Noise or garbage that was in the buffer
  189.               from the frontend was being taken by FoyerSelect as 
  190.               user input.
  191.               
  192.             - Added some feedback to the user when they selected
  193.               the "Terminate and Exit" option.
  194.               
  195.  
  196. Version 1.6 - Thanks To Andrew Pick in the UK, I found a bug where 
  197.               FoyerSelect would exit without closing the serial
  198.               device. This happened when a user would drop the
  199.               carrier.
  200.               
  201.             - Added some minor fix ups and some "just in case"
  202.               stuff.          
  203.  
  204. Version 1.7 - Thanks To Mats Kling in Sweden for a couple of good
  205.               ideas.
  206.               
  207.             - Added the -p option so that different paths can be
  208.               selected.
  209.               
  210.            - Changed the "Remain" (-r) option so that this counter
  211.              says how many times menu selections can be made.   
  212.